home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / acnfn10.zip / ACNFN.DOC < prev    next >
Text File  |  1991-11-18  |  12KB  |  310 lines
  1.              Automated Network/Conference Listing Generator
  2.  
  3.                                   v1.0
  4.  
  5.                               PCBoard 14.5a
  6.  
  7.                                    by
  8.  
  9.                               Al Lawrence
  10.  
  11.                             Sunrise-80  BBS
  12.                             (404) 256-9525
  13.  
  14.  
  15.  
  16.  
  17.                               DESCRIPTION
  18.                               ___________
  19.  
  20.  
  21. The Automated Network/Conference Listing Generator (ACNFN) is a utility that 
  22. creates the conference display file. Most Sysops use an editor to create the
  23. conference listing, more commonly called CNFN. As you add/change/delete 
  24. conferences you end up spending hours trying to realign and colorize the 
  25. display. If you happen to add a whole network, you could very well spend 
  26. more time fixing the conference listing, than creating the conferences 
  27. themselves. This utility does not create any extraneous files on disk and 
  28. uses the CNAMES file as input. There is no need to create a second file for 
  29. the colorized listing, as the program uses the @X variables made available
  30. in PCBoard v14.5. Just about everything is configurable, from verbage to colors.
  31.  
  32.  
  33.  
  34.                               INSTALLATION
  35.                               ____________
  36.  
  37.  
  38.    Installation is fairly easy and straight-forward. The following steps and
  39.    examples should have you up and running in a very short period of time.
  40.    
  41.      (1) Create a Configuration file with a name of your choice.
  42.      
  43.      (2) Run the program using the following command line:
  44.            
  45.                ACNFN   xxxx.CFG
  46.  
  47.          Where xxxx = the name used in (1) above.
  48.  
  49.  
  50.  
  51.  
  52.                              CONFIGURATION FILE
  53.                              __________________
  54.  
  55.      Line 1.   Sunrise-80 BBS
  56.      Line 2.   Al Lawrence
  57.      Line 3.   00000000
  58.      Line 4.   INPUT=C:\PCB\MAIN\CNAMES
  59.      Line 5.   OUTPUT=C:\PCB\GEN\CNFN
  60.      Line 6.   SORT=N
  61.      Line 7.   NUMCOL=LEFT
  62.      LINE 8.   NDESC=RIM:RIME
  63.      Line 9.   NETCONF=RIM:2:100:P
  64.      Line 10.  CONF=LOC:Sunrise Doors:1:1:p
  65.      Line 11.  XCNF=@X06
  66.      Line 12.  XTYP=@X0C
  67.      Line 13.  XCFN=@X0A
  68.      Line 14.  XHDB=@X1A
  69.      Line 15.  XBBS=@X1F
  70.      Line 16.  XNET=@X57
  71.      Line 17.  XBBG=@X1F
  72.      Line 18.  XMRE=@X8C
  73.      Line 19.  BLINE=R = Restricted
  74.  
  75.  
  76.  
  77. __________________________________________________________________________
  78.  
  79. Line 1.  Your BBS Name. Will Display on Heading and is mandatory
  80.  
  81. Line 2.  Sysop's First and Last Name. Does not display, but is mandatory.
  82.  
  83. Line 3.  Registration Number
  84.  
  85. Line 4.  Full Pathname\Filename of the CNAMES file. This entry is 
  86.          mandatory.
  87.  
  88. Line 5.  Full Pathname\Filename of the output file that will contain
  89.          the conference listing. This entry is mandatory. 
  90.  
  91. Line 6.  This entry indicates the SORT sequence for the conference displays.
  92.          N = Display conference's in conference NUMBER sequence.
  93.          A = Display conference's in conference NAME sequence.
  94.          This entry is mandatory.
  95.  
  96. Line 7.  This entry indicates where you would like to have the conference 
  97.          number displayed. 
  98.          LEFT  = Display it to the LEFT  of the conference name 
  99.          RIGHT = Display it to the RIGHT of the conference name.
  100.          This entry is mandatory.
  101.  
  102. Line 8.  This entry assigns a UNIQUE 3 character ID and description to each 
  103.          Network on your system. The format is|  NETWORK ID:NETWORK NAME
  104.          The Network name will appear in the header, displayed at the top of
  105.          each column of the listing for that network. One NDESC entry is
  106.          required for EACH Network you carry. The maximum size of the Network
  107.          Name is 17 characters. The program will support an Unlimited number 
  108.          of Networks. At least one is mandatory
  109.  
  110. Line 9.  This entry describes the conference numbers to be associated with
  111.          each of the conference descriptions you have defined above. At 
  112.          least one is mandatory.
  113.        
  114.          Format|  NETWORK ID:STARTING CONF. #:ENDING CONF. #:CONF. TYPE
  115.          NETWORK ID = Must match one of the IDs in line 8.
  116.          STARTING # = First conference # in a range comprising the network         
  117.          ENDING   # = Last  conference # in a range comprising the network
  118.          CONF. TYPE = P for Public Conferences, R for Restricted/Reserved
  119.                       Note: This applies to ALL the conference numbers in the
  120.                             range indicated. 
  121.         
  122.          Use multiple NETCONF entries if you have a mixture of Public and
  123.          Reserved. For example: if your RIME conferences covered numbers
  124.          1-100 and #35-37 were Reserved and all others were Public you would 
  125.          use 3 NETCONF entries. 1-34 would have a CONF TYPE of P, 35-37 would
  126.          have a CONF TYPE of R and 38-100 would have a CONF TYPE of P. You can
  127.          use any number of NETCONF entries to fully describe your conference.
  128.          
  129.  
  130. Line 10. This entry is used to assign a conference to more than one NETWORK.
  131.          This is mostly cosmetic and is NOT a required entry. In future 
  132.          versions this entry will be used by non-PCBoard systems. Optional.
  133.          Format| NETWORK ID:CON. NAME:CONF. #:CONF. TYPE
  134.          NETWORK ID = Must match one of the IDs in line 8.
  135.          CON. NAME  = Conference name up to a maximum of 13 characters
  136.          CONF. #    = Conference number up 3 digits
  137.          CONF. TYPE = Same as Line 9 above
  138.  
  139. -------------------------------------------------------------------------
  140. --- Next 8 Entries Control the Colors For Each Section of the Listing ---
  141. ---------------------- Uses @X Color Codes ------------------------------
  142. -------------------- Registered Version Only ----------------------------
  143. -------------------------------------------------------------------------
  144.  
  145. Line 11. Conference Name Color
  146. Line 12. Conference Type Color
  147. Line 13. Conference Number Color
  148. Line 14. Heading Color (box)
  149. Line 15. Heading BBS Name Color
  150. Line 16. Network Name Color
  151. Line 17. Bottom Line Color
  152. Line 18. "More" Color, on Bottom line (both ends)
  153.  
  154. Line 19. With this entry you can define what appears on the bottom line.
  155.          By default it will show "R = Restricted", in registered version.
  156.          Maximum length is 70 characters. Optional. Requires Registration!
  157.  
  158.  
  159.  
  160.  
  161. __________________________ E X A M P L E ____________________________________
  162. To help make all this a little clearer (it is really very simple), I will 
  163. describe the conferences/Networks of my BBS and what the Configuration file 
  164. would look like. Sunrise-80 BBS has 4 Networks and Local conferences. The 
  165. Networks are RIME, City2City, SmartNet and L&Lnet. Conference numbers are 
  166. assigned as follows:
  167.  
  168.            Rime     : 2-23, 25-70, 94 (all are Public except 29,30,35)
  169.            City2City: 73-93 (all are Public except 75,84,86)
  170.            L&Lnet   : 1, 71-72, 95-97 (all are Public)
  171.            SmartNet : 98-112 (all are Public)
  172.            Local    : 0, 24 (all are Public)
  173.  
  174. In addition I display my Sunrise Doors conference (conf # 1) in Local area 
  175. as well as the L&Lnet Network.
  176.  
  177. I also use all the default colors and a special bottom line. All has been
  178. included in the example CFG.
  179.  
  180. The CNFN.CFG file would look like this:
  181. _______________________________________
  182.  
  183. Sunrise-80 BBS
  184. Al Lawrence
  185. 00000000
  186. INPUT=C:\PCB\MAIN\CNAMES.@@@
  187. OUTPUT=C:\PCB\GEN\CNFN
  188. SORT=N
  189. NUMCOL=LEFT
  190. NDESC=100:R I M E
  191. NDESC=200:City2City
  192. NDESC=400:L & Lnet
  193. NDESC=300:SmartNet
  194. NDESC=500:L O C A L
  195. NETCONF=200:73:74:P
  196. NETCONF=200:75:75:r
  197. NETCONF=200:76:83:p
  198. NETCONF=200:84:84:r
  199. NETCONF=200:85:85:p
  200. NETCONF=200:86:86:r
  201. NETCONF=200:87:93:p
  202. NETCONF=100:2:23:p
  203. NETCONF=100:25:28:p
  204. NETCONF=100:29:30:r
  205. NETCONF=100:31:34:p
  206. NETCONF=100:35:35:r
  207. NETCONF=100:36:70:p
  208. NETCONF=100:94:94:p
  209. NETCONF=400:1:1:p
  210. NETCONF=400:71:72:p
  211. NETCONF=400:95:97:p
  212. NETCONF=500:0:0:p
  213. NETCONF=500:24:24:p
  214. NETCONF=300:98:112:P
  215. CONF=500:Sunrise Doors:1:p
  216. XCNF=@X06
  217. XTYP=@X0C
  218. XCFN=@X0A
  219. XHDB=@X1A
  220. XBBS=@X1F
  221. XNET=@X57
  222. XBBG=@X1F
  223. XMRE=@X8C
  224. BLINE=R = Restricted    [AVAILABLE FROM: Sunrise Doors/Utility Software]
  225.  
  226.  
  227.                         Hints/Tips/Other Ramblings
  228.                         __________________________
  229.  
  230.      (1) The sequence in which the networks appear, is controlled by the
  231.          NETWORK ID field. The program will sort on this field, therefore
  232.          it is important to assign values to each network that will place
  233.          them in the proper sequence. As you can see from the Example 
  234.          Sunrise CFG file, above, I use 3 digit numbers.
  235.  
  236.      (2) The first three(3) entries in the CFG file are required to be in
  237.          that sequence. All others may be in any sequence.
  238.  
  239.      (3) This version will only handle up to 999 conferences. Future versions
  240.          will go higher but the number of conferences displayed across the 
  241.          screen will be reduced to 3... (can't stretch the screen :) )
  242.  
  243.      (4) Be sure to use the ':' to separate fields within each Entry.
  244.  
  245.      (5) I really do not like to do documentation and therefore there may be
  246.          some errors or omissions in this document. I would appreciate any 
  247.          feedback you wish to give relative to the program itself or the Docs.
  248.  
  249.  
  250.                               LEGALITIES
  251.                               __________
  252.  
  253.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  254.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  255.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  256.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  257.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  258.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  259.       OR BREACH OF ANY WARRANTY.
  260.  
  261.  
  262.  
  263.  
  264.  
  265.                              DISTRIBUTION
  266.                              ____________
  267.  
  268.    You may make this file available for downloading from your BBS or you may
  269.    upload it to any BBS of your choice, provided that you do not make any
  270.    changes to the contents of the archive (ZIP file). The archive and its
  271.    individual contents may not be used by any service that charges any money
  272.    whatsoever, without the written permission of the author.
  273.  
  274.  
  275.  
  276.  
  277.  
  278.                              REGISTRATION
  279.                              ____________
  280.  
  281.    Registration and the subsequent insertion of the registration number into
  282.    your configuation file, allows for the display of your BBS name on the
  283.    opening screenand its display in the heading of the listing, reduction of 
  284.    delays, and the ability to change certain values in the configuration file.
  285.  
  286.    To register your copy of ACNFN, please fill out the registration form
  287.    (REGISTER.FRM) and mail it along with a small donation ($20) to the name
  288.    and address on the form.
  289.  
  290.    Be sure to use the proper upper/lower case when filling in your name and
  291.    BBS name, as they MUST match the way you entered them in the configuration
  292.    file.             ^^^^
  293.  
  294.    Based upon information supplied on the registration form, I will pre-
  295.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  296.    up your registration number.
  297.  
  298.  
  299.  
  300.                                  MISC
  301.                                  ____
  302.  
  303.    The latest version of ACNFN and other fine SUNRISE DOOR programs are 
  304.    always available for download from SUNRISE-80 BBS.
  305.  
  306.    Remember, should you have any problems, questions or suggestions, be sure
  307.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors, 
  308.    PCBHints, SYSops), SmartNet (SN_Sysops), City2City, L&Lnet, FIDO (Sysops,
  309.    PCBnet, Sysop18)
  310.